/***************************************************************************
 * Copyright 2012-2013 TXT e-solutions SpA
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * This work was performed within the IoT_at_Work Project
 * and partially funded by the European Commission's
 * 7th Framework Programme under the contract ICT-257367.
 *
 * Authors:
 *      Salvatore Piccione (TXT e-solutions SpA)
 *
 * Contributors:
 *        Domenico Rotondi (TXT e-solutions SpA)
 **************************************************************************/
package it.txt.ens.client.publisher.factory;

import it.txt.ens.client.core.ENSEvent;

import java.util.Date;
import java.util.Map;

/**
 * This interface defines methods to create {@link ENSEvent} objects to be published.
 * 
 * @author Salvatore Piccione (TXT e-solutions SpA - salvatore.piccione AT txtgroup.com)
 * @author Domenico Rotondi (TXT e-solutions SpA - domenico.rotondi AT txtgroup.com)
 *
 */
public interface ENSEventFactory {
    /**
     * Creates a new event to be published with the default content type, content encoding, and
     * priority.
     * @param headers the event headers
     * @param payload the event payload
     * @param timestamp the event timestamp <b>(since version 1.1.0 this parameter is ignored)</b>
     * @param isPersistent <code>true</code> if the event must be stored, <code>false</code> otherwise
     * @return a new <code>ENSEvent</code> object
     */
    @Deprecated
    public ENSEvent create (Map<String, Object> headers, byte[] payload, 
            Date timestamp, boolean isPersistent);
    /**
     * Creates a new event.
     * @param headers the event headers
     * @param payload the event payload
     * @param contentType the media type of the payload
     * @param contentEncoding the encoding of the payload
     * @param priority the event priority
     * @param timestamp the event timestamp <b>(since version 1.1.0 this parameter is ignored)</b>
     * @param isPersistent <code>true</code> if the event must be stored, <code>false</code> otherwise
     * @return a new <code>ENSEvent</code> object
     */
    @Deprecated
    public ENSEvent create (Map<String, Object> headers, byte[] payload,
            String contentType, String contentEncoding, int priority, 
            Date timestamp, boolean isPersistent);
    
    /**
     * Creates a new event to be published with the default content type, content encoding, and
     * priority.
     * @param headers the event headers
     * @param payload the event payload
     * @param isPersistent <code>true</code> if the event must be stored, <code>false</code> otherwise
     * @return a new <code>ENSEvent</code> object
     */
    public ENSEvent create (Map<String, Object> headers, byte[] payload, boolean isPersistent);
    
    /**
     * Creates a new event.
     * @param headers the event headers
     * @param payload the event payload
     * @param contentType the media type of the payload
     * @param contentEncoding the encoding of the payload
     * @param priority the event priority
     * @param isPersistent <code>true</code> if the event must be stored, <code>false</code> otherwise
     * @return a new <code>ENSEvent</code> object
     */
    public ENSEvent create (Map<String, Object> headers, byte[] payload,
            String contentType, String contentEncoding, int priority, boolean isPersistent);
}
